home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 2 / Gold Medal Software Volume 2 (Gold Medal) (1994).iso / prog / asm_n_z.arj / TED2.DOC < prev    next >
Text File  |  1989-10-10  |  11KB  |  225 lines
  1. ________________________________________________________________________
  2.  
  3.                             TED 
  4.                             Command
  5.  
  6.        TED was written by Tom Kihlken, and published in PC Magazine
  7.        TEDPLUS was apparently also written by Tom Kihlken
  8.        TED2 is basically TED with the character string search from TEDPLUS 
  9.     and additional modifications and enhancements by: 
  10.                 James E. Galbraith
  11.                 1201 Chase st.
  12.                 Novato CA, 94945
  13.  
  14.        TED2.COM is the executable program file.
  15.        TED2.ASM is the assembly language source code file.
  16.        TEST.BAT is used to calculate the file integrity checksum byte.
  17.  
  18.        Even though TED2 is extensively reworked from the TED version that 
  19.     was published in PC-Magazine, the PC-Magazine copyright is still 
  20.     in effect (see "The Copyright Fight", PC Magazine February 24, 1987 
  21.     pp 61,62).  I believe that this is of concern if this program were 
  22.     to be included with or incorporated in a commercial product.  
  23. ________________________________________________________________________
  24.  
  25. Purpose:    TED, the tiny text editor, is a full-screen editor for 
  26.         line-oriented files of up to 64K in length.  It supports 
  27.         scrolling, cut, copy, paste, and printing operations.  
  28.         Character string search and search again were added to 
  29.         TEDPLUS and TED2 (TED version 2.0).  TED2 allows all 256 
  30.         characters of the IBM-PC extended ASCII set (including 
  31.         <Nul>, <CR>, and <LF>) to be entered.  
  32.  
  33. Format:        TED [drive:][path]filespec
  34.  
  35. Remarks:    TED will open and read a file whose name (and path, if 
  36.         required) is initially supplied on the command line.  If 
  37.         no filespec is provided, it will open a new file and then 
  38.         prompt for a filename when <F2> is pressed to save and exit.  
  39.         A legal DOS filename, and optionally a path name, must be 
  40.         provided to close the file.  If it is desired to not close 
  41.         the file and return to edit mode, press the <Esc> key.  
  42.         TED2 also allows pressing any non-character (function or 
  43.         cursor) key to return to edit mode.  The original of a 
  44.         modified file is saved with the extension .BAK.  
  45.         The QUIT command <Shift-F2>, when verified (with <y>, <Y>, 
  46.         or <CR>), abandons any modifications and leaves the original 
  47.         file intact.  If a file has been opened for editing and 
  48.         there have been no file changes, either the <F2> or the 
  49.         <Shift-F2> key will immediately abandon the edit copy of 
  50.         the file, without altering the original file, and return to 
  51.         DOS.  If the file has the Read-only attribute set, TED2 
  52.         will open the file to allow browsing, but will not allow any 
  53.         edit changes.  There is no "load" or "save" file function 
  54.         from within TED.  
  55.  
  56.         TED uses certain DOS functions that require DOS version 2.0 
  57.         or higher to run.  TED2 has incorporated a DOS version test, 
  58.         and exits with a message if the test fails.  TED2 also 
  59.         incorporates a one-byte check sum test of program integrity, 
  60.         which gives a 99.7% confidence level that the program file 
  61.         has not been accidently corrupted.
  62.  
  63.         Lines may be any length, and each must be terminated by 
  64.         pressing <Enter> (the end-of-line marker is <CR><LF>).  
  65.         Lines longer than the screen width display a diamond in the 
  66.         rightmost column.  Offscreen characters (up to 248 columns) 
  67.         may be viewed by using the Ctrl-arrow keys to move the 
  68.         window left or right.  Lines may be broken by pressing 
  69.         <Enter> at any point, in either Insert or Overstrike mode.  
  70.         Lines may be joined by pressing <Del> at the line end or 
  71.         <Backspace> at beginning.
  72.  
  73.         One end of a "block" of text is defined by toggling the MARK 
  74.         <F4> command on, and moving the cursor with the cursor control 
  75.         keys to the other end of the block.  The marked area is shown 
  76.         in inverse video.  Pressing CUT <F5> removes it to a buffer 
  77.         from which it can be pasted <Shift-F5> at any point where the 
  78.         cursor is located.  The paste buffer remains intact until 
  79.         another section is marked and cut.  The paste buffer has room 
  80.         for 64K bytes.  If the MARK toggle is on, pressing PRINT <F3> 
  81.         prints the marked text (directly from the file buffer).  
  82.         Pressing <Shift-F3> will output a Form-feed character to 
  83.         position the printer to the top of the next page.
  84.  
  85.         Pressing DEL_L <F9> or <Shift-F8> deletes the entire line 
  86.         and closes the gap.  Pressing DEL_EOL <F8> or <Alt-D> 
  87.         deletes from the cursor position to the end of the present 
  88.         line.  Pressing UDEL_L <F10> restores the most recent line 
  89.         deletion.  The line delete buffer remains intact until 
  90.         another line is deleted.  The line delete buffer has room 
  91.         for 255 characters.
  92.  
  93.         The UNDO <F7> command restores up to 255 characters deleted 
  94.         by the <Del> key or over written while in the Overstrike mode.  
  95.         The UNDO buffer is cleared when the cursor is moved.  It 
  96.         will only restore the last key deleted with the <Backspace> 
  97.         key (the <Backspace> key is implemented as <Left-arrow><Del>). 
  98.  
  99.         TEDPLUS added a string SEARCH and SEARCH AGAIN function.  
  100.         In TED2, <F6> or <Alt-S> is SEARCH, and <Shift-F6> or 
  101.         <Alt-A> is SEARCH AGAIN.  When the <F6> is pressed, the 
  102.         prompt "SEARCH> " appears on the bottom line.  Enter the 
  103.         desired text string and press the <ENTER> key.  If the 
  104.         string is found, it appears in inverse video on the screen.  
  105.         To search for the next occurance of the string, press 
  106.         <Shift-F6>.  The inverse video is extinguished when any 
  107.         key is pressed.  
  108.         NOTE: TEDPLUS and TED2 use a DOS function to enter the search 
  109.         string.  As a result, TED2 can enter characters that cannot 
  110.         be searched for.  These are <Nul>, <LF>, <CR>, and <Esc>.
  111.  
  112.         Text is entered in insert mode by default.  Pressing the 
  113.         <Ins> key toggles between Insert and Overstrike mode.  The 
  114.         Insert/Overstrike state is displayed by an 'I' or 'O' in 
  115.         the lower right corner of the screen.  If the file has the 
  116.         Read-only attribute set, an 'R' is displayed in the lower 
  117.         right corner of the screen and no edit changes may be made 
  118.         to the file.
  119.  
  120.         The ASCII Backspace (BS) code can 
  121.         be entered as <Ctrl-H>, the Cariage return (CR) code, as 
  122.         <Ctrl-M>, and the Line feed (LF) code, as <Ctrl-J>.  The 
  123.         <Enter> key enters a new-line (CR)(LF) marker, and the 
  124.         <Backspace> key deletes the character to the left of the 
  125.         cursor.  Any of the characters in the IBM extended ASCII 
  126.         set (except <Nul>, 00H) can be entered by pressing the Alt 
  127.         key, typing its ASCII decimal value on the numeric keypad, 
  128.         then releasing the Alt key.  TED2 allows entering the <Nul> 
  129.         code with <Shift-F1>.
  130.  
  131.         TED2 does not use the CPM style End-of-file marker, <Ctrl-Z>, 
  132.         to indicate the last character in a text file.  If a Ctrl-Z 
  133.         character appears in the file, it is ignored.
  134.  
  135.         TED configures itself to the display in use, and supports 
  136.         EGA and VGA text modes other than the standard 80 columns 
  137.         by 25 rows (eg. EGA 43 lines).  It does not alter screen 
  138.         attributes or colors.  Inverse video is used to indicate 
  139.         a MARKed block.  TED2 uses blinking inverse video to indicate 
  140.         that the search string has been found.  PgUp and PgDn scroll 
  141.         the file by the number of rows displayed, minus five.  It 
  142.         automatically handles "de-snow" on a CGA display.  Because 
  143.         TED makes BIOS calls and writes directly to the screen buffer, 
  144.         it could have problems with MS-DOS computers that are not 
  145.         sufficiently IBM-PC compatible.  
  146.  
  147.         TED was written by Tom Kihlken and was published in PC 
  148.         Magazine in November 1988.  TEDPLUS appears to have also been 
  149.         written by Tom Kihlken in November 1988.  It was obtained 
  150.         from a Bulletin board service in June of 1989.  I entered 
  151.         TED from the magazine article listing when it was published.  
  152.         I found and fixed some minor bugs and added some enhancements.  
  153.         When I obtained TEDPLUS, I incorporated SEARCH and several 
  154.         other functions into my version of TED.  I also added a HELP 
  155.         screen.  TEDPLUS attempted to allow entering any key code 
  156.         into a file.  The ASCII <CR> and <LF> codes can now be 
  157.         directly entered as <Ctrl-M> and <Ctrl-J>.  If they are 
  158.         entered together, or ever become ajacent, they become an 
  159.         end-of-line marker.  The end-of-line marker may not ever be 
  160.         separated into <CR><LF> characters to keep TED2 from losing 
  161.         track of the cursor location.  The <Shft-F1> key is now used 
  162.         to enter the <Nul> character, making it possible to enter 
  163.         all of the 256 IBM extended ASCII set.  The screen update 
  164.         has been changed to look for any keys-waiting at the end of 
  165.         each line to improve the keyboard responsiveness.  This is 
  166.         especially noticable when scrolling the file up or down.  
  167.         To protect against a possible corrupted program file, there 
  168.         is a one-byte program check sum test which is run when the 
  169.         program is started.  The inverse of the check sum value is 
  170.         returned as a DOS ERRORLEVEL code (the reason it is limited 
  171.         to one byte).  If the check sum value is not zero, the 
  172.         program terminates with the message "TED altered".  
  173.         On top of everything else, TED2.COM is still a tiny program.  
  174.         It fits in 4096 bytes, four clusters on a 360K floppy disk.
  175.  
  176.  
  177.         Keypad Commands:
  178.  
  179.         Up Arrow    Moves cursor up one row
  180.         Down Arrow    Moves cursor down one row
  181.         Left Arrow    Moves cursor left one column
  182.         Right Arrow    Moves cursor rigght one column
  183.         PgUp        Moves text window up one page
  184.         PgDn        Moves text window down one page
  185.         Home        Moves cursor to start of line (if already 
  186.                 at start of line, moves up one line)
  187.         End        Moves cursor to end of line (if already at
  188.                 end of line, moves to end of next line)
  189.         Ins        Toggles Insert/Overstrike mode (I/O)
  190.         Del        Deletes character under cursor (to right)
  191.         Backspace    Deletes character to left of cursor 
  192.         Ctrl-Home    Moves text window to top of file
  193.         Ctrl-End    Moves text window to bottom of file
  194.         Ctrl-PgUp    (same as <PgUp><PgDn>, moves text window up)
  195.         Ctrl-PgDn    (same as <PgDn><PgUp>, moves text window down)
  196.         Ctrl-Right Arrow Moves text window right eight columns
  197.         Ctrl-Left Arrow Moves text window left eight columns
  198.         Esc        Enters <Esc> char/Aborts <F2> command
  199.         Ctrl-C        Enters <Ctrl-C> char (DOS abort is disabled)
  200.         Enter        Start new line, adds <CR><LF> pair to file.
  201.  
  202.  
  203.         Editing Functions:
  204.  
  205.         Help    F1    Help screen
  206.         <Nul>    Shft-F1 Adds <Nul> character (00H) to file
  207.         Exit    F2    Saves changes and exits
  208.         Quit    Shft-F2    Exits without saving changes
  209.         Print    F3    Prints the marked (by F4) text
  210.         FormFeed Shft-F3 Outputs a form feed to the printer.
  211.         Mark    F4    Toggles mark state on/off
  212.         Cut    F5    Moves marked (by F4) text to paste buffer
  213.         Paste    Shft-F5    Inserts contents of paste buffer at cursor
  214.         Search    F6    Search for a (case insensitive) string
  215.         Src/Nxt Shft-F6    Search again for same string
  216.         UnDo    F7    Replaces recently deleted characters
  217.         Del EOL    F8    Delete from cursor to the end of line
  218.         Del L    Shft-F8    Delete the current line (from Multi-Edit)
  219.         Del L    F9    Delete the current line 
  220.         Udel L    F10    Inserts the last deleted line
  221.  
  222.         Search    Alt-S    Search
  223.         Src/Nxt Alt-A    Search again
  224.         Del EOL Alt-D    Delete to EOL
  225.